Convert docs from committed HTML to Markdown source with CI build step#1
Merged
shenxianpeng merged 2 commits intomainfrom Mar 24, 2026
Merged
Conversation
- Add scripts/build_docs.py to generate HTML from Markdown at deploy time - Add docs/zh/plugin-guide.md (missing Chinese translation source) - Remove pre-compiled HTML from website/docs/ and website/zh/docs/ - Update .gitignore to exclude generated HTML directories - Update deploy-website.yml to run build script before deployment and watch docs/** path changes Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> Agent-Logs-Url: https://github.com/castops/cast-cli/sessions/a0457fb6-ae95-41e1-bca4-d85e022785eb
Copilot
AI
changed the title
[WIP] Convert document to Markdown file and remove HTML files
Convert docs from committed HTML to Markdown source with CI build step
Mar 24, 2026
shenxianpeng
approved these changes
Mar 24, 2026
shenxianpeng
approved these changes
Mar 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation was hand-authored and committed as HTML, with Markdown sources in
docs/serving no functional purpose. HTML should be a build artifact generated at deploy time, not a versioned file.Changes
Build script
scripts/build_docs.py— readsdocs/*.md+docs/zh/*.md, converts via Pythonmarkdownlibrary, injects the shared site template (CSS, nav, sidebar with active state, breadcrumbs, footer), rewrites internal.mdhrefs to.html, and writes towebsite/docs//website/zh/docs/Repository cleanup
website/docs/*.htmlandwebsite/zh/docs/*.html; these are now build outputs only.gitignore— addedwebsite/docs/andwebsite/zh/docs/to prevent re-committing generated filesMissing source file
docs/zh/plugin-guide.md— the Chinese plugin guide existed only as HTML; created the Markdown source from its contentWorkflow update
deploy-website.yml— added Python 3.11 setup,pip install markdown, andpython scripts/build_docs.pybefore the upload step; extended path trigger to includedocs/**so Markdown edits trigger a redeploywebsite/index.htmlandwebsite/zh/index.html(hand-crafted landing pages with no Markdown equivalent) are intentionally retained as static sources.Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.